Dario/0.3/doc#817
Open
dario-coscia wants to merge 5 commits into
Open
Conversation
dario-coscia
force-pushed
the
dario/0.3/doc
branch
from
810b8ca to
7d3ed07
Compare
Contributor
|
Code Coverage SummaryResults for commit: 589eb80 Minimum allowed coverage is ♻️ This comment has been updated with latest results |
dario-coscia
force-pushed
the
dario/0.3/doc
branch
from
7d3ed07 to
5f76832
Compare
dario-coscia
force-pushed
the
dario/0.3/doc
branch
from
724eed8 to
abf06bd
Compare
GiovanniCanali
left a comment
GiovanniCanali
left a comment
Collaborator
There was a problem hiding this comment.
I'm just leaving two comments below.
Collaborator
Author
Checklist
|
GiovanniCanali
requested changes
Jun 26, 2026
GiovanniCanali
left a comment
GiovanniCanali
left a comment
Collaborator
There was a problem hiding this comment.
Thank you for the PR. I have a few requests before merging:
- Please use a consistent structure for the
.rstfiles. For example,docs/source/_rst/adaptive_function/adaptive_celu.rstanddocs/source/_rst/graph/graph_builder.rstcurrently do not follow the same format. Adapt all files. - Base classes and interfaces should not include examples, since they are not meant to be instantiated directly and this may confuse users.
- Private classes should not include examples, as they are intended for internal use only.
- Examples should be included only in the source (
pina/_src) files. Please remove the examples currently included in the.rstfiles or import files (e.g.,pina/callbackinstead ofpina/_src/callback).
Collaborator
There was a problem hiding this comment.
Remove class description and examples, keep only rst-relevant information.
Collaborator
There was a problem hiding this comment.
Remove class description and examples, keep only rst-relevant information.
Collaborator
There was a problem hiding this comment.
Remove class description and examples, keep only rst-relevant information.
| class AdaptiveFunctionInterface(metaclass=ABCMeta): | ||
| """ | ||
| Abstract interface for all adaptive functions. | ||
|
|
Collaborator
There was a problem hiding this comment.
remove this example, out of scope
| physics-informed neural networks*. | ||
| Journal of Computational Physics, 404. | ||
| DOI: `JCP 10.1016 <https://doi.org/10.1016/j.jcp.2019.109136>`_. | ||
Collaborator
There was a problem hiding this comment.
Remove this example, out of scope
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR fixes #818
Checklist